package com.dimples.dd.system.service;

import com.dimples.dd.common.pojo.PageResult;
import com.dimples.dd.system.model.entity.SystemSmsLogDO;
import com.baomidou.mybatisplus.extension.service.IService;
import com.dimples.dd.system.model.entity.SystemSmsTemplateDO;
import com.dimples.dd.system.model.query.SmsLogPageQuery;
import com.dimples.dd.system.model.vo.SmsLogPageVO;

import java.time.LocalDateTime;
import java.util.Map;

public interface SystemSmsLogService extends IService<SystemSmsLogDO> {

    /**
     * 短信日志分页
     *
     * @param pageQuery 查询条件
     * @return 分页数据
     */
    PageResult<SmsLogPageVO> selectSmsLogPage(SmsLogPageQuery pageQuery);

    /**
     * 创建短信日志
     *
     * @param mobile          手机号
     * @param userId          用户编号
     * @param userType        用户类型
     * @param isSend          是否发送
     * @param template        短信模板
     * @param templateContent 短信内容
     * @param templateParams  短信参数
     * @return 发送日志编号
     */
    Long createSmsLog(String mobile, Long userId, Integer userType, Boolean isSend,
                      SystemSmsTemplateDO template, String templateContent, Map<String, Object> templateParams);

    /**
     * 更新日志的发送结果
     *
     * @param id           日志编号
     * @param success      发送是否成功
     * @param apiSendCode  短信 API 发送结果的编码
     * @param apiSendMsg   短信 API 发送失败的提示
     * @param apiRequestId 短信 API 发送返回的唯一请求 ID
     * @param apiSerialNo  短信 API 发送返回的序号
     */
    void updateSmsSendResult(Long id, Boolean success,
                             String apiSendCode, String apiSendMsg,
                             String apiRequestId, String apiSerialNo);

    /**
     * 更新日志的接收结果
     *
     * @param id             日志编号
     * @param success        是否接收成功
     * @param receiveTime    用户接收时间
     * @param apiReceiveCode API 接收结果的编码
     * @param apiReceiveMsg  API 接收结果的说明
     */
    void updateSmsReceiveResult(Long id, Boolean success, LocalDateTime receiveTime, String apiReceiveCode, String apiReceiveMsg);
}
